Skip to content

feat: add CometAPI integration with CometAPIChatGenerator class and configuration #2345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 78 commits into
base: main
Choose a base branch
from
Open

feat: add CometAPI integration with CometAPIChatGenerator class and configuration #2345

wants to merge 78 commits into from
+1,743 −0

Conversation

@garybadwal
Copy link
Contributor

@garybadwal garybadwal commented Sep 27, 2025 •
edited by sjrl
Loading

Related Issues

Proposed Changes

Added a new CometAPIChatGenerator class that extends OpenAIChatGenerator to support the Comet API as a backend for chat generation.

  • Configures api_base_url to point to https://api.cometapi.com/v1.
  • Supports authentication via COMET_API_KEY environment variable (using Secret.from_env_var).
  • Allows configuration of model name, streaming callbacks, tools, retry logic, and HTTP client kwargs, same as OpenAIChatGenerator.
  • Default model is set to gpt-4o-mini.

This provides a seamless way to use CometAPI as a drop-in replacement for OpenAI within Haystack.

How did you test it?

  • Verified initialization of CometAPIChatGenerator with and without explicit parameters.
  • Tested that it correctly inherits all functionality from OpenAIChatGenerator.
  • Manually checked API base URL override (api_base_url = https://api.cometapi.com/v1).
  • Confirmed loading of API key from environment variable (COMET_API_KEY).

Notes for the reviewer

  • The main change is introducing the CometAPIChatGenerator class.
  • Implementation reuses all OpenAIChatGenerator logic, only customizing api_base_url and defaults.
  • Please review whether we should add integration tests with a real Comet API key (currently avoided to keep CI clean).

Checklist

garybadwal and others added 30 commits May 24, 2025 16:24
@garybadwal
feat: Add GoogleAITextEmbedder and GoogleAIDocumentEmbedder components
85a7ef2
@garybadwal
fix: Improve error messages for input type validation in GoogleAIText…
b9f94c7 
…Embedder and GoogleAIDocumentEmbedder
@garybadwal
Merge branch 'deepset-ai:main' into main
15fd085
@garybadwal
feat: add Google GenAI embedder components for document and text embe…
682a4e2 
…ddings
@garybadwal
feat: add unit tests for GoogleAIDocumentEmbedder and GoogleAITextEmb…
778f702 
…edder
@garybadwal
refactor: clean up imports and improve list handling in GoogleAIDocum…
3de6d1e 
…entEmbedder and GoogleAITextEmbedder tests
@garybadwal
Merge branch 'main' into main
7fcfb14
@garybadwal
Merge branch 'main' into main
c85dadb
@garybadwal
refactor: Rename classes and update imports for Google GenAI components
9c6cb1a
@garybadwal
feat: Add additional modules for Google GenAI embedders in config
89bb3be
@garybadwal
Merge branch 'main' into main
ea0c0c9
@garybadwal
Merge branch 'main' into main
814f53c
@garybadwal
chore: add 'more-itertools' to lint environment dependencies
f2d2a0c
@garybadwal
refactor: update GoogleGenAIDocumentEmbedder and GoogleGenAITextEmbed…
171ab37 
…der to use private attributes for initialization
@garybadwal
refactor: update _prepare_texts_to_embed to return a list instead of …
f20bdff 
…a dictionary
@garybadwal
refactor: format code for better readability and consistency in docum…
38525c0 
…ent embedder
@garybadwal
refactor: improve code formatting for consistency and readability in …
f8e5f8a 
…document embedder and tests
@garybadwal
refactor: update _prepare_texts_to_embed to return a list instead of …
666d0d5 
…a dictionary
@garybadwal
feat: add new author to project metadata in pyproject.toml
0b8d687
@garybadwal
Merge branch 'main' into main
c323a34
@garybadwal
Merge branch 'main' into main
94b31ae
@garybadwal
feat: add asynchronous embedding methods for GoogleGenAIDocumentEmbed…
706de87 
…der and GoogleGenAITextEmbedder
@garybadwal
Merge branch 'main' of https://github.com/garybadwal/haystack-core-in…
e9a3a4b 
…tegrations into main
@garybadwal
Merge branch 'main' into google-genai-embedders-async-runs
ef9dd82
@garybadwal
Merge pull request #1 from garybadwal/google-genai-embedders-async-runs
5271ff4 
Google genai embedders async runs
@garybadwal
fix: ensure consistent formatting for pylint
818e40d
@garybadwal
fix: update return type annotation for run_async method in GoogleGenA…
4909c01 
…IDocumentEmbedder
@garybadwal
fix: update return type annotation for run_async method in GoogleGenA…
8f6f9f1 
…ITextEmbedder
@davidsbatista
Merge branch 'main' into main
37c5c12
@garybadwal
fix: update return type annotation and handle None values in _embed_b…
60a4506 
…atch_async method
@garybadwal
Copy link
Contributor Author

Hi @sjrl, just checking if you or @TensorNull can give a review to the changes requested. So I can fix things if required.

TensorNull

This comment was marked as resolved.

Sign in to view

TensorNull
TensorNull approved these changes Oct 17, 2025
View reviewed changes
Copy link

@TensorNull TensorNull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@garybadwal
Copy link
Contributor Author

Thank you, @TensorNull! I’d also like to give a special thanks to @sjrl, who was the first person I connected with when I submitted my very first open-source contribution — the text and document embedder integration for Google GenAI. Since then, I’ve received continuous support from all of you.

I’m truly grateful to be part of such a welcoming community that helps new contributors like me.

I look forward to contributing to Haystack in the future and staying in touch with you all. Thank you again for your constant support and guidance!

@garybadwal
Copy link
Contributor Author

Hi @sjrl, just checking if we can merge this PR.

@mpangrazzi mpangrazzi self-requested a review October 21, 2025 13:19
mpangrazzi
mpangrazzi reviewed Oct 21, 2025
View reviewed changes
Copy link
Contributor

@mpangrazzi mpangrazzi left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@garybadwal

I think you still need to address this?

Update: we should keep README consistent with other ones (so a lot more minimal).

The current README should be instead placed as a comet-api.md file in that folder, with links / examples.

sjrl
sjrl reviewed Oct 22, 2025
View reviewed changes
@garybadwal
Copy link
Contributor Author

@sjrl @mpangrazzi I have done the changes ✅

@garybadwal garybadwal requested review from mpangrazzi and sjrl October 24, 2025 07:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sjrl sjrl Awaiting requested review from sjrl

@mpangrazzi mpangrazzi Awaiting requested review from mpangrazzi

1 more reviewer

@TensorNull TensorNull TensorNull approved these changes

Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

integration:cometapi topic:CI type:documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feature request: Add CometAPI as an LLM provider

5 participants

@garybadwal @sjrl @mpangrazzi @TensorNull @davidsbatista